Skip to content

chore: update module validation #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Behzad-rabiei merged 1 commit into from
Sep 15, 2025
Merged

chore: update module validation #483

Behzad-rabiei merged 1 commit into from
Sep 15, 2025

Conversation

@Behzad-rabiei
Copy link
Member

@Behzad-rabiei Behzad-rabiei commented Sep 15, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Module creation now defaults to Activated when the setting is omitted. If you don’t specify an activation status, the module is created as active by default. This reduces required fields, streamlines setup, and prevents errors from missing activation values. Applies to both UI forms and API requests. Requests that explicitly set activation to true or false continue to behave as before.

@coderabbitai
Copy link

coderabbitai bot commented Sep 15, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The createModule validation schema in src/validations/module.validation.ts changed the body field activated from a required boolean to an optional boolean with default true. No other schemas or logic were modified.

Changes

Cohort / File(s) Summary
Validation schema update
src/validations/module.validation.ts		 In createModule body schema, activated changed from Joi.boolean().required() to Joi.boolean().default(true), making it optional with an implicit default of true.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Client
  participant API as Modules API
  participant V as Joi Validation

  C->>API: POST /modules { name, ... , [activated]? }
  API->>V: Validate request body (createModule schema)
  alt activated omitted
    Note over V: Apply default: activated = true
  else activated provided
    Note over V: Use provided boolean value
  end
  V-->>API: Validated payload
  API-->>C: Proceed with creation using validated payload
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nudge the schema, soft and light,
A switch now defaults to sunny bright.
No fuss, no squeak—true by design,
Carrots aligned in validation line.
Hop, approve, and onward move—
Optional fields with a cheerful groove. 🥕✨

✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch module-validation-update
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e4b4c1 and e8f8f15.

📒 Files selected for processing (1)
  • src/validations/module.validation.ts (1 hunks)

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Behzad-rabiei Behzad-rabiei merged commit 808e817 into main Sep 15, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Behzad-rabiei